Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Oct 10, 2025

Overview

This PR refactors the "Default Safety Values" tip from docs/howto/bootstrap/collect.md into a reusable includable file, following the same pattern established in PR #1010 for other decision point tips.

Changes

Created

  • docs/_includes/default_safety_values.md - New includable file containing the "Default Safety Values" tip that recommends assuming a marginal Safety Impact when no information is available about the device's environment.

Modified

  • docs/howto/bootstrap/collect.md - Replaced the inline tip with {% include-markdown "../../_includes/default_safety_values.md" %} to reference the new includable file.

  • docs/reference/decision_points/safety_impact.md - Added the include in two strategic locations:

    • After the "See also" tip block, making the default value recommendation visible on the main Safety Impact reference page
    • At the beginning of the "Gathering Information About Safety Impact" section, providing guidance where it's most relevant for users gathering information about this decision point

Benefits

  • DRY Principle: The tip content is now defined once and reused in multiple places, making maintenance easier
  • Consistency: Users see the same default value recommendation whether they're reading the data collection guide, the reference documentation, or the gathering information section
  • Maintainability: Future updates to the default safety values guidance only need to be made in one place

Related Issues

Closes #[issue number] (child of #522)

Pattern Consistency

This refactoring follows the established pattern for includable tips, consistent with:

  • _includes/automatable_cvss_ssvc.md
  • _includes/value_density_cvss_ssvc.md
  • _includes/safety_cvss_ssvc.md
Original prompt

This section details on the original issue you should resolve

<issue_title>Refactor default safety values in collect.md into an includable</issue_title>
<issue_description>Child of #522

  • Refactor the Default Safety Values tip from docs/howto/bootstrap/collect.md into an includable file in docs/_includes
  • Replace the tip in collect.md with the included tip
  • Include the tip to the decision point reference page docs/reference/decision_points/safety_impact.md
  • Include the tip in the "gathering info" page for safety
    </issue_description>

<agent_instructions>This is very similar to the changes in PR #1010, follow those as an example.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes #963


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@Copilot Copilot AI changed the title [WIP] Refactor default safety values into includable file Refactor default safety values tip into an includable file Oct 10, 2025
@Copilot Copilot AI requested a review from ahouseholder October 10, 2025 20:48
Copilot finished work on behalf of ahouseholder October 10, 2025 20:48
@ahouseholder ahouseholder marked this pull request as ready for review October 14, 2025 16:40
@ahouseholder ahouseholder requested review from Copilot and removed request for cgyarbrough, j--- and sei-vsarvepalli October 14, 2025 16:40
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refactors the "Default Safety Values" tip from inline content into a reusable includable file, enabling consistent presentation of safety impact guidance across multiple documentation pages.

  • Extracted the default safety values tip into a dedicated includable file
  • Replaced inline tip content with include statements in affected files
  • Added the tip to the Safety Impact reference page and its gathering information section

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/_includes/default_safety_values.md New includable file containing the default safety values tip with updated relative path
docs/howto/bootstrap/collect.md Replaced inline tip with include statement
docs/reference/decision_points/safety_impact.md Added include statements in two strategic locations for better visibility

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@ahouseholder ahouseholder added the content/representation Formatting, page layout, syntax, etc. label Oct 14, 2025
@ahouseholder ahouseholder changed the base branch from main to copilot/refactor-default-exploitation-values October 14, 2025 18:11
@ahouseholder ahouseholder merged commit 96fd1af into copilot/refactor-default-exploitation-values Oct 14, 2025
5 checks passed
@ahouseholder ahouseholder deleted the copilot/refactor-default-safety-values branch October 14, 2025 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content/representation Formatting, page layout, syntax, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refactor default safety values in collect.md into an includable

2 participants